.. _cemHomeMove:

cemHomeMove
==============
--------------


SYNOPSYS
`````````````
.. code-block:: none

 VT_I4 cemHomeMove(
    [in] VT_I4 Axis, [in] VT_I4 IsBlocking
    )


DESCRIPTION
`````````````

- 원점 복귀 작업을 수행합니다.



PARAMETER
`````````````
- Axis : Axis : 축 번호. 통합 축으로 관리되는 축 번호를 의미하며, 상수 값으로 0 (Zero Based) 이상, 
  (최대 통합 축 개수 – 1) 이하의 값을 축 번호로 설정할 수 있습니다.


- IsBlocking :  cemHomeMove 함수의 인자이며, 완료될 때까지 기다리는 동안 윈도우 메시지를
  블록(Blocking)할 것인지를 결정합니다. 단, 쓰레드내에서 실행할 때는 이 값을 1(CE_TRUE)로 설정해 주어야 합니다.

+--------------+----------------------------------------------------------------------------------------------------------------+
| Value        | Meaning                                                                                                        |
+==============+================================================================================================================+
| 0 (CE_FALSE) | 윈도우 메시지를 블록(Blocking) 하지 않습니다. 따라서 해당 모션이 진행되는 동안 윈도우 이벤트를 처리합니다.     |
+--------------+----------------------------------------------------------------------------------------------------------------+
| 1 (CE_TRUE)  | 윈도우 메시지를 블록(Blocking) 합니다. 따라서 해당 모션이 완료되는 동안에는 윈도우 이벤트가 처리되지 않습니다. |
+--------------+----------------------------------------------------------------------------------------------------------------+



RETURN VALUE
`````````````

- 함수 수행 여부를 반환합니다.

+----------------+-----------+
| Value          | Meaning   |
+================+===========+
| 음수           | 수행 실패 |
+----------------+-----------+
| 0 (ceERR_NONE) | 수행 성공 |
+----------------+-----------+


REFERENCE
```````````

- cemHomeMoveStart 함수를 사용하는 경우에는 cemHomeIsBusy, cemHomeWaitDone, 
  cemHomeSuccess_Get 함수를 사용하여 모션의 완료를 확인할 수 있습니다.

\

- ccemHomeMove 함수를 사용하는 경우에는 내부적으로 루프를 수행하면서 모션이 완료되기를
  기다리는데, 이때 블록 모드(Blocking Mode) 설정에 따라 윈도우 이벤트를 처리하는 방식이
  달라집니다. 그러나 일반적으로 윈도우의 작업 쓰레드(Work Thread) 에서는 블록 모드를 사용하여, 
  함수 내부에서 지연 없이 쓰레드 내부의 작업에 집중할 수 있도록 설정하는 것이 바람직합니다.

\

- INP 입력신호가 Enable 로 설정되었으면 Command 펄스 출력이 완료되어도 INP 입력이 ON 이
  되기 전까지는 모션이 완료되지 않은 것으로 간주되어 반환되지 않습니다. 

\

- 스텝 드라이버를 사용 중인 고객님들께서는 다음을 참조해 주십시오.
  스텝 드라이버는 INP 출력이 없는 경우가 일반적인데, 고객님의 부주의나 잘못된 설정으로 INP 입력에
  대한 설정이 Enable 로 되어 있을 경우 INP 입력이 스텝 드라이버를 통해 발생하지 않는 이유 때문에
  모션 완료가 되지 않는 경우가 발생할 수 있습니다. 고객 여러분들께서는 스텝 드라이버 사용시에
  이점을 주의하시기 바랍니다.

\

- 서보 드라이버의 LSP, LSN 신호를 사용 중인 고객님께서는 다음을 참조해 주십시오.
  서보드라이버의 입력 신호 중 하나인 EL(End of Limit) 신호는 저희 ㈜ 커미조아 모션 컨트롤러뿐만
  아니라 서보드라이버에도 전달 될 수 있도록 설정할 수 있습니다. 통상적으로 LSP 신호와 LSN 신호로
  불리어 지는 이 신호는 실제 기구물에서 양의 방향(Positive Direction) 혹은 음의 방향(Negative 
  Direction) 에 장착되어 있는 EL 신호를 서보 드라이버 측에 전달하기 위한 용도로 사용됩니다.

  그러나, 모션 소프트웨어에서 INP 설정이 되어 있는 경우 EL 신호가 검출 된 후에 일부 서보 드라이버
  에서는 진행 방향에서 정지한 후 더 이상 움직이지 않는 상황이 발생하며, 이 상황에서 INP 신호가
  출력되지 않아, 모션 이송이 완료되지 못하고, 명시적으로 STOP 명령을 통해 강제적으로 모션을

  종료해야 되는 현상이 발생할 수 있습니다. 이 현상은 EL 모드를 통해 원점 복귀를 하는 상황에서도
  발생할 수 있습니다.
  따라서, 이러한 경우에는 반드시 원점 복귀나 EL 검출 시에 인터럽트 이벤트나 타이머를 통해 INP 를
  무기한 대기하는 현상에 대해서 적절히 대처하시거나 INP 신호 사용을 배제 해야 합니다.

.. note:: 윈도우 이벤트라는 것은 무엇입니까?
    윈도우 운영체제는 Event Driven 혹은 Message Driven 방식의 구조로 되어있습니다. 각
    응용 프로그램은 메시지 큐(Queue)를 가지고 있으며, 정확히 말하면, 메시지를 사용해
    이벤트를 통지하는 방식으로 설계되어 있습니다. 윈도우 메시지를 처리한다는 것은
    메시지 큐에서 메시지를 하나씩 꺼내서 윈도우 프로시저에 전송한다는 것을 의미하며, 
    이것은 그 행선지가 되는 윈도우에 전송되어 처리됩니다.





EXAMPLE
```````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

 C/C++

 #include “ceSDK.h”
 #include “ceSDKDef.h”

 /*********************************************************************
 * 원점 복귀 환경을 설정합니다.
 *********************************************************************/
 void OnSetHomeConfig ()
 {
    /* 원점 복귀 환경을 원점 복귀 모드 = 0, 방향 = (-), Ez Count = 0, 
    원점 탈출 거리 = 10, Offset = 0 으로 설정합니다. */
    cemHomeConfig_Set ( cemX1, 0, cemDIR_N, 0, 10, 0 );
    cemHomeConfig_Set ( cemY1, 0, cemDIR_N, 0, 10, 0 );

    /* 원점 복귀 속도 환경을 설정합니다. */
    cemHomeSpeedPattern_Set ( cemX1, cemSMODE_S, 1000, 10000, 10000, 10 );
    cemHomeSpeedPattern_Set ( cemY1, cemSMODE_S, 1000, 10000, 10000, 10 );
 }

 /*********************************************************************
 * 원점 복귀 이송을 수행합니다.
 *********************************************************************/
 void OnHomeReturn ()
 {
    long nIsHomming = CE_TRUE; // 원점 복귀 진행 상태 정보

    /* cemHomeIsBusy() 명령을 통한 원점 복귀 완료 체크 */
    if ( cemHomeMoveStart ( cemX1 ) == ceERR_NONE )
    {
        While ( nIsHomming )
        {
        cemHomeIsBusy ( cemX1, &nIsHomming );
        // 0 (CE_FALSE) : 원점 복귀 이송 작업이 진행중이지 않습니다.
        // 1 (CE_TRUE) : 원점 복귀 이송 작업이 진행중입니다.
        }
    }

    // cemHomeWaitDone() 명령을 통한 원점 복귀 완료 체크.
    if ( cemHomeMoveStart ( cemY1 ) == ceERR_NONE )
    {
        cemHomeWaitDone ( cemY1, CE_FALSE ); // 원점 복귀 완료 시까지 대기합니다.
    }

    // cemHomeMoveStart(), cemHomeWaitDone() 을 아래 코드로 대체 할 수 있습니다.
    // cemHomeMove ( cemY1, CE_FALSE );
 }

 /*********************************************************************
 * 원점 복귀 성공 여부를 확인합니다.
 *********************************************************************/
 void OnGetHomeSuccess ()
 {
    long nIsSuccess;

    // 원점 복귀 성공 여부를 확인합니다.
    cemHomeSuccess_Get ( cemX1, &nIsSuccess );

    if ( nIsSuccess == CE_TRUE )
    {
        // 원점 복귀가 성공했음을 의미합니다.
    }
 }


.. code-block:: none
 :linenos:

 Visual Basic

 ‘ ==============================================
 ‘ 원점 복귀 환경을 설정합니다.
 ‘==============================================
 Private Sub OnSetHomeConfig ()

    ‘ 원점 복귀 환경을 원점 복귀 모드 = 0, 방향 = (-), Ez Count = 0, 
    ‘ 원점 탈출 거리 = 10, Offset = 0 으로 설정합니다.
    Call cemHomeConfig_Set ( cemX1, 0, cemDIR_N, 0, 10, 0 )
    Call cemHomeConfig_Set ( cemY1, 0, cemDIR_N, 0, 10, 0 )

    ‘ 원점 복귀 속도 환경을 설정합니다.
    Call cemHomeSpeedPattern_Set ( cemX1, cemSMODE_S, 1000, 10000, 10000, 10 )
    Call cemHomeSpeedPattern_Set ( cemY1, cemSMODE_S, 1000, 10000, 10000, 10 )

 End Sub

 ‘ ==============================================
 ‘ 원점 복귀 이송을 수행합니다.
 ‘ ==============================================
 Private OnHomeReturn ()

    Dim nIsHomming As Long ‘ 원점 복귀 진행 상태 정보
    nIsHomming = CE_TRUE

    ‘ cemHomeIsBusy() 명령을 통한 원점 복귀 완료 체크
    If cemHomeMoveStart ( cemX1 ) = ceERR_NONE Then
    
        While ( nIsHomming = CE_TRUE )
            ‘ 0 (CE_FALSE) : 원점 복귀 이송 작업이 진행중이지 않습니다.
            ‘ 1 (CE_TRUE) : 원점 복귀 이송 작업이 진행중입니다.
            Call cemHomeIsBusy ( cemX1, nIsHomming )
        Wend
    End If

    ‘ cemHomeWaitDone() 명령을 통한 원점 복귀 완료 체크.
    If cemHomeMoveStart ( cemY1 ) = ceERR_NONE Then
        Call cemHomeWaitDone ( cemY1, CE_FALSE ) ‘ 원점 복귀 완료 시까지 대기합니다.
    End If

    ‘ cemHomeMoveStart(), cemHomeWaitDone() 을 아래 코드로 대체 할 수 있습니다.
    ‘ cemHomeMove( cemY1, CE_FALSE )

 End Sub

 ‘ ==============================================
 ‘ 원점 복귀 성공 여부를 확인합니다.
 ‘ ==============================================
 Private Sub OnGetHomeSuccess ()
 
    Dim nIsSuccess As Long ‘ 원점 복귀 성공 여부 정보.

    ‘ 원점 복귀 성공 여부를 확인합니다.
    Call cemHomeSuccess_Get ( cemX1, nIsSuccess )

    ‘ 원점 복귀 성공 메시지를 표시합니다.
    If nIsSuccess = CE_TRUE Then
        MsgBox ( "Home return success" )
    End If

 End Sub

.. code-block:: none
 :linenos:

 Delphi

 // ********************************************************************
 // 원점 복귀 환경을 설정합니다.
 // ********************************************************************
 procedure OnSetHomeConfig ();
 begin
    { 원점 복귀 환경을 원점 복귀 모드 = 0, 방향 = (-), Ez Count = 0,    
    원점 탈출 거리 = 10, Offset = 0 으로 설정합니다. }
    cemHomeConfig_Set ( cemX1, 0, cemDIR_N, 0, 10, 0 );
    cemHomeConfig_Set ( cemY1, 0, cemDIR_N, 0, 10, 0 );

    // 원점 복귀 속도 환경을 설정합니다.
    cemHomeSpeedPattern_Set ( cemX1, cemSMODE_S, 1000, 10000, 10000, 10 );
    cemHomeSpeedPattern_Set ( cemY1, cemSMODE_S, 1000, 10000, 10000, 10 );

 end;

 // ********************************************************************
 // 원점 복귀 이송을 수행합니다.
 // ********************************************************************
 procedure OnHomeReturn ();
 var

    nIsHomming : LongInt // 원점 복귀 진행 상태 정보

 begin
    // cemHomeIsBusy() 명령을 통한 원점 복귀 완료 체크
    if cemHomeMoveStart ( cemX1 ) = ceERR_NONE then
    begin
        nIsHomming := CE_TRUE;
        while nIsHomming = CE_TRUE do
        begin
            { 0 (CE_FALSE) : 원점 복귀 이송 작업이 진행중이지 않습니다.
            1 (CE_TRUE) : 원점 복귀 이송 작업이 진행중입니다. }
            cemHomeIsBusy ( cemX1, @nIsHomming );
        end;
    end;

    // cemHomeWaitDone() 명령을 통한 원점 복귀 완료 체크.
    if cemHomeMoveStart ( cemY1 ) = ceERR_NONE then
    begin
        cemHomeWaitDone ( cemY1, CE_FALSE ); // 원점 복귀 완료 시까지 대기합니다.
    end

    // cemHomeMoveStart(), cemHomeWaitDone() 을 아래 코드로 대체 할 수 있습니다.
    // cemHomeMove( cemY1, CE_FALSE );

 end;

 // ********************************************************************
 // 원점 복귀 성공 여부를 확인합니다.
 // ********************************************************************
 procedure OnGetHomeSuccess ();
 var
    nIsSuccess : LongInt // 원점 복귀 성공 여부 정보.
 begin
    // 원점 복귀 성공 여부를 확인합니다.
    cemHomeSuccess_Get ( cemX1, @nIsSuccess );

    // 원점 복귀 성공 메시지를 표시합니다.
    if nIsSuccess = CE_TRUE then
    begin
        ShowMessage ( ‘Home return success’ );
    end;

 end;



.. seealso:: :ref:`cemHomeMoveStart`